﻿<!DOCTYPE html><html lang="zh-CN" data-bs-theme="light"><head>
    <meta charset="utf-8">
      <title>docfx-seed | docfx seed website </title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="docfx-seed | docfx seed website ">
      
      
      <link rel="icon" href="favicon.ico">
      <style class="anchorjs"></style><link rel="stylesheet" href="public/docfx.min.css">
      <link rel="stylesheet" href="public/main.css">
      <meta name="docfx:navrel" content="toc.html">
      <meta name="docfx:tocrel" content="toc.html">
      
      <meta name="docfx:rel" content="">
      <meta name="docfx:disablenewtab" content="true">
      
      <meta name="docfx:docurl" content="https://github.com/dotnet/docfx/blob/main/samples/seed/index.md/#L1">
      <meta name="loc:inThisArticle" content="In this article">
      <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
      <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
      <meta name="loc:tocFilter" content="Filter by title">
      <meta name="loc:nextArticle" content="Next">
      <meta name="loc:prevArticle" content="Previous">
      <meta name="loc:themeLight" content="Light">
      <meta name="loc:themeDark" content="Dark">
      <meta name="loc:themeAuto" content="Auto">
      <meta name="loc:changeTheme" content="Change theme">
      <meta name="loc:copy" content="Copy">
      <meta name="loc:downloadPdf" content="Download PDF">
  <script type="module" src="./public/docfx.min.js"></script><script>
    const theme = localStorage.getItem('theme') || 'auto'
    document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
  </script></head>

  

  


  <body class="tex2jax_ignore" data-layout="landing" data-yaml-mime="">
    <header class="bg-body border-bottom">
      <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
        <div class="container-xxl flex-nowrap">
          <a class="navbar-brand" href="https://github.com/dotnet/docfx">
            <img id="logo" class="svg" src="logo.svg" alt="Seed">
            Seed
          </a>
          <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
            <i class="bi bi-three-dots"></i>
          </button>
          <div class="collapse navbar-collapse" id="navpanel">
            <div id="navbar">
              <form class="search" role="search" id="search">
                <i class="bi bi-search"></i>
                <input class="form-control" id="search-query" type="search" placeholder="Search" autocomplete="off" aria-label="Search">
              </form>
            
    <ul class="navbar-nav"><li class="nav-item"><a class="nav-link active" aria-current="page" href="http://localhost:8089/index.html">Home</a></li><li class="nav-item"><a class="nav-link " aria-current="false" href="http://localhost:8089/articles/docfx_getting_started.html">Articles</a></li>
            <li class="nav-item dropdown">
              <a href="#" role="button" data-bs-toggle="dropdown" aria-expanded="false" class="nav-link dropdown-toggle ">
                API Documentation
              </a>
              <ul class="dropdown-menu"><li class="nav-item"><a class="nav-link " aria-current="false" href="http://localhost:8089/api/BuildFromAssembly.html">.NET API</a></li><li class="nav-item"><a class="nav-link " aria-current="false" href="http://localhost:8089/md/BuildFromAssembly.html">.NET API (markdown)</a></li><li class="nav-item"><a class="nav-link " aria-current="false" href="http://localhost:8089/apipage/BuildFromAssembly.html">.NET API (apipage)</a></li><li class="nav-item"><a class="nav-link " aria-current="false" href="http://localhost:8089/restapi/petstore.html">REST API</a></li></ul>
            </li></ul> 
      <form class="icons">
        <a class="btn border-0" href="https://github.com/dotnet/docfx" title="GitHub"><i class="bi bi-github"></i></a><a class="btn border-0" href="https://twitter.com/" title="Twitter"><i class="bi bi-twitter"></i></a>
        
    <div class="dropdown">
      <a class="btn border-0 dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false" title="Change theme">
        <i class="bi bi-circle-half"></i>
      </a>
      <ul class="dropdown-menu dropdown-menu-end">
        <li><a class="dropdown-item" href="#"><i class="bi bi-sun"></i> Light</a></li>
        <li><a class="dropdown-item" href="#"><i class="bi bi-moon"></i> Dark</a></li>
        <li><a class="dropdown-item" href="#"><i class="bi bi-circle-half"></i> Auto</a></li>
      </ul>
    </div>
      </form></div>
          </div>
        </div>
      </nav>
    </header>

    <main class="container-xxl">
      <div class="toc-offcanvas">
        <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
          <div class="offcanvas-header">
            <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
            <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
          </div>
          <div class="offcanvas-body">
            <nav class="toc" id="toc">
      
      <form class="filter">
        <i class="bi bi-filter"></i>
        <input class="form-control" type="search" autocomplete="off" value="" placeholder="Filter by title" aria-label="Filter by title">
      </form> 
      <div class="flex-fill overflow-y-auto"><ul>
        <li class=" active ">
          
          <a class="  " href="http://localhost:8089/index.html">Home</a>
          
        </li>
        <li class="  ">
          
          <a class=" nav-link " href="http://localhost:8089/articles/docfx_getting_started.html">Articles</a>
          
        </li>
        <li class=" expander ">
          <span class="expand-stub"></span>
          <a href="#" class=" nav-link ">API Documentation</a>
          <ul>
        <li class="  ">
          
          <a class=" nav-link " href="http://localhost:8089/api/BuildFromAssembly.html">.NET API</a>
          
        </li>
        <li class="  ">
          
          <a class=" nav-link " href="http://localhost:8089/md/BuildFromAssembly.html">.NET API (markdown)</a>
          
        </li>
        <li class="  ">
          
          <a class=" nav-link " href="http://localhost:8089/apipage/BuildFromAssembly.html">.NET API (apipage)</a>
          
        </li>
        <li class="  ">
          
          <a class=" nav-link " href="http://localhost:8089/restapi/petstore.html">REST API</a>
          
        </li></ul>
        </li></ul></div>
      <div class="py-2 mb-md-4"><a class="pdf-link" href="http://localhost:8089/toc.pdf">Download PDF</a></div></nav>
          </div>
        </div>
      </div>

      <div class="content">
        <div class="actionbar">
          <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
            <i class="bi bi-list"></i>
          </button>

          <nav id="breadcrumb">
        <ol class="breadcrumb">
          <li class="breadcrumb-item"><a href="http://localhost:8089/index.html">Home</a></li>
        </ol></nav>
        </div>

        <article data-uid="">
<h1 id="docfx-seed">docfx-seed</h1>

<h2 id="description">Description<a class="anchorjs-link " aria-label="Anchor" data-anchorjs-icon="#" href="#description" style="margin-left: 0.1875em; padding-right: 0.1875em; padding-left: 0.1875em;"></a></h2>
<p>This is a sample docfx documentation project. It contains .NET source code and markdown files.
<code>docfx.json</code> is the configuration file for running <code>docfx</code>.
<code>docfx</code> will generate a static website as similar to <a href="http://docascode.github.io/docfx-seed/index.html">http://docascode.github.io/docfx-seed</a>.</p>
<h2 id="how-to-run">How to run<a class="anchorjs-link " aria-label="Anchor" data-anchorjs-icon="#" href="#how-to-run" style="margin-left: 0.1875em; padding-right: 0.1875em; padding-left: 0.1875em;"></a></h2>
<h3 id="under-windows">Under Windows<a class="anchorjs-link " aria-label="Anchor" data-anchorjs-icon="#" href="#under-windows" style="margin-left: 0.1875em; padding-right: 0.1875em; padding-left: 0.1875em;"></a></h3>
<ul>
<li>Download and unzip <a href="https://github.com/dotnet/docfx/releases/latest">docfx.zip</a> to run <code>docfx.exe</code> directly!</li>
<li>Run <code>docfx</code> under current repo! Website will be generated under <code>_site</code> folder.</li>
<li>Run any web hosting tool to host <code>_site</code> folder, e.g. <code>docfx serve _site</code>.</li>
</ul>
<h3 id="cross-platform-and-use-dnx">Cross platform and use <code>dnx</code><a class="anchorjs-link " aria-label="Anchor" data-anchorjs-icon="#" href="#cross-platform-and-use-dnx" style="margin-left: 0.1875em; padding-right: 0.1875em; padding-left: 0.1875em;"></a></h3>
<p>As a prerequisite, you will need to install <a href="http://docs.asp.net/en/latest/getting-started/installing-on-windows.html#install-the-net-version-manager-dnvm">DNVM</a> and <a href="http://docs.asp.net/en/latest/getting-started/installing-on-windows.html#install-the-net-execution-environment-dnx">DNX</a>.
###Quick Start</p>
<ul>
<li><p><code>dnvm upgrade</code> to get the latest dnvm.</p>
</li>
<li><p>Add feed <a href="https://www.myget.org/F/aspnetrelease/api/v2/">https://www.myget.org/F/aspnetrelease/api/v2/</a> to Nuget.config</p>
<blockquote>
<p>For Windows, the nuget config file is  <strong>%AppData%\NuGet\NuGet.config</strong>.</p>
</blockquote>
<blockquote>
<p>For Linux/OSX, the nuget config file is <strong>~/.config/NuGet/NuGet.config</strong>.</p>
</blockquote>
<pre><code data-highlighted="yes" class="hljs language-undefined"></code></pre>
</li>
<li><p><code>dnu commands install docfx</code> to install <code>docfx</code> as a command</p>
</li>
<li><p>Run <code>docfx</code> under current repo! Website will be generated under <code>_site</code> folder.</p>
</li>
<li><p>Run any web hosting tool to host <code>_site</code> folder, e.g. <code>docfx serve _site</code>.</p>
</li>
</ul>
<h2 id="further-information-about-docfx">Further information about <code>docfx</code><a class="anchorjs-link " aria-label="Anchor" data-anchorjs-icon="#" href="#further-information-about-docfx" style="margin-left: 0.1875em; padding-right: 0.1875em; padding-left: 0.1875em;"></a></h2>
<p><code>docfx</code> is a tool to generate documentation towards .NET source code and markdown files. Please refer to <a href="http://dotnet.github.io/docfx/tutorial/docfx_getting_started.html">docfx</a> to get start. The <code>docfx</code> website itself is generated by <code>docfx</code>!</p>

</article>

        <div class="contribution d-print-none">
          <a href="https://github.com/dotnet/docfx/blob/main/samples/seed/index.md/#L1" class="edit-link">Edit this page</a>
        </div>

        <div class="next-article d-print-none border-top" id="nextArticle"> <div class="next"><span>Next <i class="bi bi-chevron-right"></i></span> <a rel="next" href="http://localhost:8089/articles/docfx_getting_started.html">Articles</a></div></div>

      </div>

      <div class="affix">
        <nav id="affix">
      <h5 class="border-bottom">In this article</h5>
      <ul><li><a class="link-body-emphasis" href="#description">Description</a></li><li><a class="link-body-emphasis" href="#how-to-run">How to run</a></li><li><a class="link-secondary" href="#under-windows">Under Windows</a></li><li><a class="link-secondary" href="#cross-platform-and-use-dnx">Cross platform and use dnx</a></li><li><a class="link-body-emphasis" href="#further-information-about-docfx">Further information about docfx</a></li></ul></nav>
      </div>
    </main>

    <div class="container-xxl search-results" id="search-results"></div>

    <footer class="border-top text-secondary">
      <div class="container-xxl">
        <div class="flex-fill">
          <span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
        </div>
      </div>
    </footer>
  

</body></html>